<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>s3.objects.S3Bucket</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="s3-module.html">Package&nbsp;s3</a> ::
        <a href="s3.objects-module.html">Module&nbsp;objects</a> ::
        Class&nbsp;S3Bucket
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="s3.objects.S3Bucket-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class S3Bucket</h1><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket">source&nbsp;code</a></span><br /><br />
<center>
<center>  <map id="uml_class_diagram_for_s3_objec" name="uml_class_diagram_for_s3_objec">
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#__str__" title="str(x)" alt="" coords="19,37,467,56" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#has_key" title="Does key exists in bucket." alt="" coords="19,56,467,75" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="19,75,467,93" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#save" title="Save an S3Object into bucket." alt="" coords="19,93,467,112" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#head" title="Get an object&#39;s headers from bucket." alt="" coords="19,112,467,131" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#__getitem__" title="Get an S3Object from bucket." alt="" coords="19,131,467,149" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#get" title="Get an S3Object from the bucket." alt="" coords="19,149,467,168" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#keys" title="Returns a flat list of object keys in bucket." alt="" coords="19,168,467,187" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#__delitem__" title="Delete a key from bucket." alt="" coords="19,187,467,205" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#items" title="Returns (key, value) pairs, where, keys are object names, and values are  S3Objects." alt="" coords="19,205,467,224" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#list" title="List bucket objects." alt="" coords="19,224,467,243" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#values" title="List bucket objects." alt="" coords="19,243,467,261" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#__repr__" title="repr(x)" alt="" coords="19,261,467,280" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html#delete" title="Delete an S3Object, a key or list of keys or objects from bucket." alt="" coords="19,280,467,299" />
<area shape="rect" href="s3.objects.S3Bucket&#45;class.html" title="s3.objects.S3Bucket" alt="" coords="7,7,479,305" />
</map>
  <img src="uml_class_diagram_for_s3_objec.gif" alt='' usemap="#uml_class_diagram_for_s3_objec" ismap="ismap" class="graph-without-title">
</center></center>
<hr />
<p>S3Bucket class</p>
  Behaves like a dictionary of keys in the bucket, with some additional 
  methods.<br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">connection</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for 
      signature
  </td>
</tr>
<tr class="private">
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#_request" class="summary-sig-name">_request</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">method</span>=<span class="summary-sig-default">''</span>,
        <span class="summary-sig-arg">obj</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">send_io</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">params</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">*args</span>)</span>
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      str(x)
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      repr(x)
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">S3Object</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#get" class="summary-sig-name">get</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Get an S3Object from the bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">dict</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#head" class="summary-sig-name">head</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">key</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Get an object's headers from bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#list" class="summary-sig-name">list</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">marker</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">max_keys</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">delimiter</span>=<span class="summary-sig-default">None</span>)</span><br />
      List bucket objects.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#save" class="summary-sig-name">save</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">s3object</span>,
        <span class="summary-sig-arg">headers</span>=<span class="summary-sig-default">{}</span>)</span><br />
      Save an S3Object into bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">objects</span>)</span><br />
      Delete an S3Object, a key or list of keys or objects from 
      bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#keys" class="summary-sig-name">keys</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">marker</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">max_keys</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">delimiter</span>=<span class="summary-sig-default">None</span>)</span><br />
      Returns a flat list of object keys in bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#values" class="summary-sig-name">values</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">marker</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">max_keys</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">delimiter</span>=<span class="summary-sig-default">None</span>)</span><br />
      List bucket objects.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">list</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#items" class="summary-sig-name">items</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns (key, value) pairs, where, keys are object names, and 
      values are S3Objects.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#has_key" class="summary-sig-name">has_key</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">key</span>)</span><br />
      Does key exists in bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">key</span>)</span><br />
      Get an S3Object from bucket.
  </td>
</tr>
<tr>
  <td width="15%" align="right" valign="top" class="summary">
    <span class="summary-type">&nbsp;</span>
  </td><td class="summary">
    <span class="summary-sig"><a href="s3.objects.S3Bucket-class.html#__delitem__" class="summary-sig-name">__delitem__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">s3object</span>)</span><br />
      Delete a key from bucket.
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__setattr__</code>
      </p>
    </td>
  </tr>
</table>

<br />
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>

<br />
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">connection</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature
  <dl><dt></dt><dd>
    <dl><dt>Overrides:
      object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="_request"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_request</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">method</span>=<span class="sig-default">''</span>,
        <span class="sig-arg">obj</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">send_io</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">params</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">*args</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket._request">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Informal representation operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.__str__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />str(x)
  <dl><dt></dt><dd>
    <dl><dt>Overrides:
      object.__str__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Representation operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.__repr__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />repr(x)
  <dl><dt></dt><dd>
    <dl><dt>Overrides:
      object.__repr__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="get"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">key</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.get">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Get an S3Object from the bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>key</code></strong> (string) - Key of the object</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Dictionary of additional headers</li>
    </ul>
    <dl><dt>Returns: S3Object</dt>
        <dd>Selected S3Object if found or None</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="head"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">head</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">key</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.head">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Get an object's headers from bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>key</code></strong> (string) - Key of the object</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Dictionary of additional headers</li>
    </ul>
    <dl><dt>Returns: dict</dt>
        <dd>Dictionary of object headers</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="list"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">list</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">prefix</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">marker</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">max_keys</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">delimiter</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.list">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />List bucket objects.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>prefix</code></strong> (string) - Limits the response to keys which begin with the indicated 
          prefix. You can use prefixes to separate a bucket into different 
          sets of keys in a way similar to how a file system uses 
          folders.</li>
        <li><strong class="pname"><code>marker</code></strong> (string) - Indicates where in the bucket to begin listing. The list will 
          only include keys that occur lexicographically after marker. This
          is convenient for pagination: To get the next page of results use
          the last key of the current page as the marker.</li>
        <li><strong class="pname"><code>max_keys</code></strong> (int) - The maximum number of keys you'd like to see in the response 
          body. The server may return fewer than this many keys, but will 
          not return more.</li>
        <li><strong class="pname"><code>delimiter</code></strong> (char) - Causes keys that contain the same string between the prefix 
          and the first occurrence of the delimiter to be rolled up into a 
          single result element in the CommonPrefixes collection. These 
          rolled-up keys are not returned elsewhere in the response.</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="save"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">save</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">s3object</span>,
        <span class="sig-arg">headers</span>=<span class="sig-default">{}</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.save">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Save an S3Object into bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>s3object</code></strong> (S3Object) - An S3Object that has to be saved</li>
        <li><strong class="pname"><code>headers</code></strong> (dict) - Dictionary of additional headers</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">objects</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Delete an S3Object, a key or list of keys or objects from bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>objects</code></strong> (S3Object, string, list of S3Objects or list of strings) - S3Object, S3Object key, or list of both to be deleted</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="keys"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">keys</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">prefix</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">marker</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">max_keys</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">delimiter</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.keys">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Returns a flat list of object keys in bucket.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>prefix</code></strong> (string) - Limits the response to keys which begin with the indicated 
          prefix. You can use prefixes to separate a bucket into different 
          sets of keys in a way similar to how a file system uses 
          folders.</li>
        <li><strong class="pname"><code>marker</code></strong> (string) - Indicates where in the bucket to begin listing. The list will 
          only include keys that occur lexicographically after marker. This
          is convenient for pagination: To get the next page of results use
          the last key of the current page as the marker.</li>
        <li><strong class="pname"><code>max_keys</code></strong> (int) - The maximum number of keys you'd like to see in the response 
          body. The server may return fewer than this many keys, but will 
          not return more.</li>
        <li><strong class="pname"><code>delimiter</code></strong> (char) - Causes keys that contain the same string between the prefix 
          and the first occurrence of the delimiter to be rolled up into a 
          single result element in the CommonPrefixes collection. These 
          rolled-up keys are not returned elsewhere in the response.</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="values"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">values</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">prefix</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">marker</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">max_keys</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">delimiter</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.list">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />List bucket objects.
  <dl><dt></dt><dd>
    <dl><dt>Parameters:</dt></dl>
    <ul class="nomargin">
        <li><strong class="pname"><code>prefix</code></strong> (string) - Limits the response to keys which begin with the indicated 
          prefix. You can use prefixes to separate a bucket into different 
          sets of keys in a way similar to how a file system uses 
          folders.</li>
        <li><strong class="pname"><code>marker</code></strong> (string) - Indicates where in the bucket to begin listing. The list will 
          only include keys that occur lexicographically after marker. This
          is convenient for pagination: To get the next page of results use
          the last key of the current page as the marker.</li>
        <li><strong class="pname"><code>max_keys</code></strong> (int) - The maximum number of keys you'd like to see in the response 
          body. The server may return fewer than this many keys, but will 
          not return more.</li>
        <li><strong class="pname"><code>delimiter</code></strong> (char) - Causes keys that contain the same string between the prefix 
          and the first occurrence of the delimiter to be rolled up into a 
          single result element in the CommonPrefixes collection. These 
          rolled-up keys are not returned elsewhere in the response.</li>
    </ul>
  </dd></dl>
</td></tr></table>
</div>
<a name="items"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">items</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.items">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Returns (key, value) pairs, where, keys are object names, and values 
  are S3Objects.
  <dl><dt></dt><dd>
    <dl><dt>Returns: list</dt>
        <dd>List of (bucket name, bucket) pairs</dd></dl>
  </dd></dl>
</td></tr></table>
</div>
<a name="has_key"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">has_key</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.has_key">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Does key exists in bucket.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="__getitem__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__getitem__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">key</span>)</span>
    <br /><em class="fname">(Indexing operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.__getitem__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Get an S3Object from bucket.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<a name="__delitem__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__delitem__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">s3object</span>)</span>
    <br /><em class="fname">(Index deletion operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="s3.objects-pysrc.html#S3Bucket.__delitem__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <br />Delete a key from bucket.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="s3-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">Generated by Epydoc
        3.0alpha3 on Wed Sep 20 12:10:43 2006</td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
